<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dsi2rx: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dsi2rx
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__dsi2rx.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaadb1544327c1439ba3f228abf4804e9b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#gaadb1544327c1439ba3f228abf4804e9b">XDsi2Rx_CfgInitialize</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr, <a class="el" href="struct_x_dsi2_rx___config.html">XDsi2Rx_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:gaadb1544327c1439ba3f228abf4804e9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance provided by the caller based on the given Config structure.  <a href="#gaadb1544327c1439ba3f228abf4804e9b">More...</a><br/></td></tr>
<tr class="separator:gaadb1544327c1439ba3f228abf4804e9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65a43a81fab8a3ad7fcef5f03ad53585"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#ga65a43a81fab8a3ad7fcef5f03ad53585">XDsi2Rx_Reset</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga65a43a81fab8a3ad7fcef5f03ad53585"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will do a reset of the IP.  <a href="#ga65a43a81fab8a3ad7fcef5f03ad53585">More...</a><br/></td></tr>
<tr class="separator:ga65a43a81fab8a3ad7fcef5f03ad53585"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad2aafbf53090a3e04a8c1fcac80c54e2"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#gad2aafbf53090a3e04a8c1fcac80c54e2">XDsi2Rx_DefaultConfigure</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr)</td></tr>
<tr class="memdesc:gad2aafbf53090a3e04a8c1fcac80c54e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will configure protocol reg with video mode, Blank packet mode, Blank packet Type, End of Transmisstion packet.  <a href="#gad2aafbf53090a3e04a8c1fcac80c54e2">More...</a><br/></td></tr>
<tr class="separator:gad2aafbf53090a3e04a8c1fcac80c54e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19af397133295c990ad132a86b515819"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#ga19af397133295c990ad132a86b515819">XDsi2Rx_Activate</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr, XDsi2Rx_Selection Flag)</td></tr>
<tr class="memdesc:ga19af397133295c990ad132a86b515819"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will enable/disable the IP Core to start processing.  <a href="#ga19af397133295c990ad132a86b515819">More...</a><br/></td></tr>
<tr class="separator:ga19af397133295c990ad132a86b515819"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga732edd1bd3354efe3715f684a341f873"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#ga732edd1bd3354efe3715f684a341f873">XDsi2Rx_GetConfigParams</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr, <a class="el" href="struct_x_dsi2_rx___config_parameters.html">XDsi2Rx_ConfigParameters</a> *ConfigInfo)</td></tr>
<tr class="memdesc:ga732edd1bd3354efe3715f684a341f873"><td class="mdescLeft">&#160;</td><td class="mdescRight">this function will get the information from the gui settings and other protocol control register values like pixel mode, pixel format.  <a href="#ga732edd1bd3354efe3715f684a341f873">More...</a><br/></td></tr>
<tr class="separator:ga732edd1bd3354efe3715f684a341f873"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9633779add7d621518de100c3361bb41"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsi2rx.html#ga9633779add7d621518de100c3361bb41">XDsi2Rx_SelfTest</a> (<a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga9633779add7d621518de100c3361bb41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs a self-test on the driver/device.  <a href="#ga9633779add7d621518de100c3361bb41">More...</a><br/></td></tr>
<tr class="separator:ga9633779add7d621518de100c3361bb41"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga19af397133295c990ad132a86b515819"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2Rx_Activate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XDsi2Rx_Selection&#160;</td>
          <td class="paramname"><em>Flag</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will enable/disable the IP Core to start processing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance to operate on.</td></tr>
    <tr><td class="paramname">Flag</td><td>will be used to indicate Enable or Disable action.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On enabling/disabling the core.</li>
</ul>
</dd></dl>
<ul>
<li>XST_INVALID_PARAM if user passes invalid parameter.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx.html#a57889229cf2847a9a249edb2f05213fd">XDsi2Rx::IsReady</a>.</p>

</div>
</div>
<a class="anchor" id="gaadb1544327c1439ba3f228abf4804e9b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2Rx_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx___config.html">XDsi2Rx_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance provided by the caller based on the given Config structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance to operate on. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>is the device configuration structure containing information about a specific DSI. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS Initialization was successful.</li>
<li>XST_FAILURE Initialization was unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx___config.html#a07d0063d512e6ffd4582b60b3a07f884">XDsi2Rx_Config::BaseAddr</a>, <a class="el" href="struct_x_dsi2_rx.html#ad839d6712558a4ba874bdbd23a277b07">XDsi2Rx::Config</a>, <a class="el" href="struct_x_dsi2_rx.html#a57889229cf2847a9a249edb2f05213fd">XDsi2Rx::IsReady</a>, and <a class="el" href="struct_x_dsi2_rx.html#a2b6cd6b63c8fe1358aea1340a9b49029">XDsi2Rx::UnSupportedDataTypeCallback</a>.</p>

</div>
</div>
<a class="anchor" id="gad2aafbf53090a3e04a8c1fcac80c54e2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2Rx_DefaultConfigure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will configure protocol reg with video mode, Blank packet mode, Blank packet Type, End of Transmisstion packet. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance to operate on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On enabling the core.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx.html#a57889229cf2847a9a249edb2f05213fd">XDsi2Rx::IsReady</a>, and <a class="el" href="struct_x_dsi2_rx.html#a1f65ac6290f33a82b8d943158c570aa6">XDsi2Rx::PixelMode</a>.</p>

</div>
</div>
<a class="anchor" id="ga732edd1bd3354efe3715f684a341f873"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2Rx_GetConfigParams </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx___config_parameters.html">XDsi2Rx_ConfigParameters</a> *&#160;</td>
          <td class="paramname"><em>ConfigInfo</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>this function will get the information from the gui settings and other protocol control register values like pixel mode, pixel format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instanceptr</td><td>is the xdsi2rx instance to operate on </td></tr>
    <tr><td class="paramname">configinfo</td><td>is going to be filled up by this function and returned to the caller.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none. </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx___config.html#a07d0063d512e6ffd4582b60b3a07f884">XDsi2Rx_Config::BaseAddr</a>, <a class="el" href="struct_x_dsi2_rx___config_parameters.html#ae6843da1fb5e14b90353827fecbcf8c7">XDsi2Rx_ConfigParameters::Config</a>, <a class="el" href="struct_x_dsi2_rx.html#ad839d6712558a4ba874bdbd23a277b07">XDsi2Rx::Config</a>, and <a class="el" href="struct_x_dsi2_rx___config_parameters.html#ac6ca53bfa1d1b660c58b5709f14b81b5">XDsi2Rx_ConfigParameters::PixelMode</a>.</p>

</div>
</div>
<a class="anchor" id="ga65a43a81fab8a3ad7fcef5f03ad53585"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDsi2Rx_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will do a reset of the IP. </p>
<p>Register ISR gets reset. Internal FIFO(command queue) gets flushed. FSM stops processing further packets. Controller gracefully ends by waiting for the current sub-block in operation to complete its task and mark next byte as LP byte to end the transfer. Once soft reset is released, controller start from VSS packet. (that is new video frame)</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance to operate on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="ga9633779add7d621518de100c3361bb41"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDsi2Rx_SelfTest </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dsi2_rx.html">XDsi2Rx</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Runs a self-test on the driver/device. </p>
<p>This test checks if the Pixel mode has been set.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_dsi2_rx.html" title="The XDsi2Rx driver instance data. ">XDsi2Rx</a> instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if self-test was successful</li>
<li>XST_FAILURE if the read value was not equal to GUI parameter</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_dsi2_rx___config.html#a07d0063d512e6ffd4582b60b3a07f884">XDsi2Rx_Config::BaseAddr</a>, <a class="el" href="struct_x_dsi2_rx.html#ad839d6712558a4ba874bdbd23a277b07">XDsi2Rx::Config</a>, and <a class="el" href="struct_x_dsi2_rx.html#a57889229cf2847a9a249edb2f05213fd">XDsi2Rx::IsReady</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
